<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="UTF-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
	<title>Configure a lifecycle policy | ElasticSearch 7.7 权威指南中文版</title>
	<meta name="keywords" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <meta name="description" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
	<link rel="stylesheet" type="text/css" href="../static/styles.css" />
	<script>
	var _link = 'set-up-lifecycle-policy.html';
    </script>
</head>
<body>
<div class="main-container">
    <section id="content">
        <div class="content-wrapper">
            <section id="guide" lang="zh_cn">
                <div class="container">
                    <div class="row">
                        <div class="col-xs-12 col-sm-8 col-md-8 guide-section">
                            <div style="color:gray; word-break: break-all; font-size:12px;">原英文版地址: <a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.7/set-up-lifecycle-policy.html" rel="nofollow" target="_blank">https://www.elastic.co/guide/en/elasticsearch/reference/7.7/set-up-lifecycle-policy.html</a>, 原文档版权归 www.elastic.co 所有<br/>本地英文版地址: <a href="../en/set-up-lifecycle-policy.html" rel="nofollow" target="_blank">../en/set-up-lifecycle-policy.html</a></div>
                        <!-- start body -->
                  <div class="page_header">
<strong>重要</strong>: 此版本不会发布额外的bug修复或文档更新。最新信息请参考 <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html" rel="nofollow">当前版本文档</a>。
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [7.7]</a></span>
»
<span class="breadcrumb-link"><a href="index-lifecycle-management.html">ILM: Manage the index lifecycle</a></span>
»
<span class="breadcrumb-node">Configure a lifecycle policy <a id="ilm-policy-definition"></a></span>
</div>
<div class="navheader">
<span class="prev">
<a href="ilm-wait-for-snapshot.html">« Wait for snapshot</a>
</span>
<span class="next">
<a href="index-lifecycle-error-handling.html">Resolve lifecycle policy execution errors »</a>
</span>
</div>
<div class="chapter xpack">
<div class="titlepage"><div><div>
<h2 class="title">
<a id="set-up-lifecycle-policy"></a>Configure a lifecycle policy <a id="ilm-policy-definition"></a><a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ilm/set-up-lifecycle-policy.asciidoc">edit</a><a class="xpack_tag" href="https://www.elastic.co/subscriptions"></a>
</h2>
</div></div></div>
<p>For ILM to manage an index, a valid policy
must be specified in the <code class="literal">index.lifecycle.name</code> index setting.</p>
<p>To configure a lifecycle policy for <a class="xref" href="index-rollover.html" title="Rollover">rolling indices</a>,
you create the policy and add it to the <a class="xref" href="indices-templates.html" title="Put index template API">index template</a>.</p>
<p>To use a policy to manage an index that doesn’t roll over,
you can specify a lifecycle policy when you create it.</p>
<p>ILM policies are stored in the global cluster state and can be included in snapshots
by setting <code class="literal">include_global_state</code> to <code class="literal">true</code> when you <a class="xref" href="snapshots-take-snapshot.html" title="Take a snapshot of one or more indices">take the snapshot</a>.
When the snapshot is restored, all of the policies in the global state are restored and any local policies with the same names are overwritten.</p>
<div class="important admon">
<div class="icon"></div>
<div class="admon_content">
<p>When you enable index lifecycle management for Beats or the Logstash Elasticsearch output plugin,
the necessary policies and configuration changes are applied automatically.
You can modify the default policies, but you do not need to explicitly configure a policy or
bootstrap an initial index.</p>
</div>
</div>
<h3>
<a id="ilm-create-policy"></a>Create lifecycle policy<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ilm/set-up-lifecycle-policy.asciidoc">edit</a>
</h3>
<p>You use the <a class="xref" href="ilm-put-lifecycle.html" title="Create lifecycle policy API">create policy API</a> to define a new lifecycle policy.
For example, the following request creates <code class="literal">my_policy</code>, a
policy that defines a hot and and delete phase.
When the index reaches 25GB, it rolls over directly to the delete phase.
The index is deleted 30 days after rollover.</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">PUT _ilm/policy/my_policy
{
  "policy": {
    "phases": {
      "hot": {
        "actions": {
          "rollover": {
            "max_size": "25GB" <a id="CO431-1"></a><i class="conum" data-value="1"></i>
          }
        }
      },
      "delete": {
        "min_age": "30d",
        "actions": {
          "delete": {} <a id="CO431-2"></a><i class="conum" data-value="2"></i>
        }
      }
    }
  }
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/1122.console"></div>
<div class="calloutlist">
<table border="0" summary="Callout list">
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO431-1"><i class="conum" data-value="1"></i></a></p>
</td>
<td align="left" valign="top">
<p>Roll over the index when it reaches 25GB in size</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO431-2"><i class="conum" data-value="2"></i></a></p>
</td>
<td align="left" valign="top">
<p>Delete the index 30 days after rollover</p>
</td>
</tr>
</table>
</div>
<h3>
<a id="apply-policy-template"></a>Apply lifecycle policy with an index template<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ilm/set-up-lifecycle-policy.asciidoc">edit</a>
</h3>
<p>To use a policy that triggers the rollover action,
you need to configure the policy in the index template used to create each new index.</p>
<p>In addition to specifying the name of the policy in the <code class="literal">index.lifecycle.name</code> setting,
you specify a <code class="literal">index.lifecycle.rollover_alias</code> for referencing
the indices managed by this policy.</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">PUT _template/my_template
{
  "index_patterns": ["test-*"], <a id="CO432-1"></a><i class="conum" data-value="1"></i>
  "settings": {
    "number_of_shards": 1,
    "number_of_replicas": 1,
    "index.lifecycle.name": "my_policy", <a id="CO432-2"></a><i class="conum" data-value="2"></i>
    "index.lifecycle.rollover_alias": "test-alias" <a id="CO432-3"></a><i class="conum" data-value="3"></i>
  }
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/1123.console"></div>
<div class="calloutlist">
<table border="0" summary="Callout list">
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO432-1"><i class="conum" data-value="1"></i></a></p>
</td>
<td align="left" valign="top">
<p>Use this template for all new indices whose names begin with <code class="literal">test-</code></p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO432-2"><i class="conum" data-value="2"></i></a></p>
</td>
<td align="left" valign="top">
<p>Apply <code class="literal">my_policy</code> to new indices created with this template</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO432-3"><i class="conum" data-value="3"></i></a></p>
</td>
<td align="left" valign="top">
<p>Define an index alias for referencing indices managed by <code class="literal">my_policy</code></p>
</td>
</tr>
</table>
</div>
<h4>
<a id="create-initial-index"></a>Create an initial managed index<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ilm/set-up-lifecycle-policy.asciidoc">edit</a>
</h4>
<p>You need to manually create the first index managed by a policy that uses the rollover action
and designate it as the write index.
The name of the index must match the pattern defined in the index template and end with a number.
This number is incremented to generate the name of indices created by the rollover action.</p>
<p>For example, the following request creates the <code class="literal">test-00001</code> index.
Because it matches the index pattern specified in <code class="literal">my_template</code>,
Elasticsearch automatically applies the settings from that template.</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">PUT test-000001
{
  "aliases": {
    "test-alias":{
      "is_write_index": true <a id="CO433-1"></a><i class="conum" data-value="1"></i>
    }
  }
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/1124.console"></div>
<div class="calloutlist">
<table border="0" summary="Callout list">
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO433-1"><i class="conum" data-value="1"></i></a></p>
</td>
<td align="left" valign="top">
<p>Set this initial index to be the write index for this alias.</p>
</td>
</tr>
</table>
</div>
<p>Now you can start indexing data to the rollover alias specified in the lifecycle policy.
With the sample <code class="literal">my_policy</code> policy, the rollover action is triggered once the initial
index exceeds 25GB.
ILM then creates a new index that becomes the write index for the <code class="literal">test-alias</code>.</p>
<h3>
<a id="apply-policy-manually"></a>Apply lifecycle policy manually<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ilm/set-up-lifecycle-policy.asciidoc">edit</a>
</h3>
<p>When you create an index, you can apply a lifecycle policy
by specifying the <code class="literal">index.lifecycle.name</code> setting.
This causes ILM to immediately start managing the index.</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">PUT test-index
{
  "settings": {
    "number_of_shards": 1,
    "number_of_replicas": 1,
    "index.lifecycle.name": "my_policy"
  }
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/1125.console"></div>
<div class="important admon">
<div class="icon"></div>
<div class="admon_content">
<p>Do not manually apply a policy that uses the rollover action.
Policies that use rollover must be applied by the <a class="xref" href="set-up-lifecycle-policy.html#apply-policy-template" title="Apply lifecycle policy with an index template">index template</a>.
Otherwise, the policy is not carried forward when the rollover action creates a new index.</p>
</div>
</div>
<h4>
<a id="apply-policy-multiple"></a>Apply a policy to multiple indices<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ilm/set-up-lifecycle-policy.asciidoc">edit</a>
</h4>
<p>You can apply the same policy to multiple indices by using wildcards in the index name
when you call the <a class="xref" href="indices-update-settings.html" title="Update index settings API">update settings</a> API.</p>
<div class="warning admon">
<div class="icon"></div>
<div class="admon_content">
<p>Be careful that you don’t inadvertently match indices that you don’t want to modify.</p>
</div>
</div>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">PUT mylogs-pre-ilm*/_settings <a id="CO434-1"></a><i class="conum" data-value="1"></i>
{
  "index": {
    "lifecycle": {
      "name": "mylogs_policy_existing"
    }
  }
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/1126.console"></div>
<div class="calloutlist">
<table border="0" summary="Callout list">
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO434-1"><i class="conum" data-value="1"></i></a></p>
</td>
<td align="left" valign="top">
<p>Updates all indices with names that start with <code class="literal">mylogs-pre-ilm</code></p>
</td>
</tr>
</table>
</div>
</div>
<div class="navfooter">
<span class="prev">
<a href="ilm-wait-for-snapshot.html">« Wait for snapshot</a>
</span>
<span class="next">
<a href="index-lifecycle-error-handling.html">Resolve lifecycle policy execution errors »</a>
</span>
</div>
</div>

                  <!-- end body -->
                        </div>
                        <div class="col-xs-12 col-sm-4 col-md-4" id="right_col">
                        
                        </div>
                    </div>
                </div>
            </section>
        </div>
    </section>
</div>
<script src="../static/cn.js"></script>
</body>
</html>